home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / PG / BASXRF.ZIP / BASICXR.DOC < prev    next >
Encoding:
Text File  |  1994-06-03  |  14.8 KB  |  339 lines
  1.                      BASICXR  Cross Reference Utility
  2.                        Copyright 1994 by JNGoodale
  3.                         _______
  4.                    ____|__     |                (R)
  5.                 --|       |    |-------------------
  6.                   |   ____|__  |  Association of
  7.                   |  |       |_|  Shareware
  8.                   |__|   o   |    Professionals
  9.                 -----|   |   |---------------------
  10.                      |___|___|    MEMBER
  11.  
  12.  
  13.     -------------------------------------------------------------------------
  14.  
  15.                 Start-up ................................. 1
  16.                 Command Line Options and Switches ........ 1
  17.                 Printer Control .......................... 3
  18.                 Selective Printing and Page Eject ........ 3
  19.                 Reserved Word Files ...................... 4
  20.                 Requirements/Limitations ................. 5
  21.                 Support and Registration ................. 5
  22.                 Shareware Concept/Ombudsman information .. 6
  23.  
  24.     ====================================================================
  25.  
  26.     OVERVIEW
  27.  
  28.         This program will cross reference a program written in Microsoft's
  29.         QBasic, QuickBasic and PDS that do NOT contain line numbers.
  30.  
  31.         It will create the following, based on options selected:
  32.  
  33.               Formatted program listing - Full List or Selected List
  34.               User label cross reference - Includes three sections:
  35.                        Line Labels                         
  36.                        Variables
  37.                        1 Ref Only - to quickly spot items (lines labels
  38.                                     or variables) referenced only once.
  39.               Reserved Word cross reference 
  40.         
  41.         Output can be to a File or Printer.
  42.  
  43.         If you are running the unregisered version, a registration reminder
  44.         and option to register are displayed at the beginning and end of the
  45.         program.
  46.  
  47.         The registered version functions identically, but the registration 
  48.         reminder is removed and it is about  6K shorter.  You receive this 
  49.         version when you register.
  50.        
  51.                                                                       Page 1
  52.  
  53.     START-UP
  54.  
  55.         To get started, copy all the files on this distribution disk to
  56.         a separate directory, such as \XREF.
  57.  
  58.         To try the program, enter -
  59.                     BASICXR
  60.                         or
  61.                     BASICXR/M if you have a monochrome or B&W monitor.
  62.  
  63.         A sample program has been included (AMORT.BAS) for your test.
  64.         Three "Reserved Word" files are also included, but not needed
  65.         if you are using QuickBasic.  See "Reserved Word Files", below.
  66.  
  67.         In order to use BASICXR, you must launch it from the directory
  68.         where the program(s) to be processed reside.  BASICXR.COM can be
  69.         in the same directory, or any directory stated in your "PATH"
  70.         command.
  71.  
  72.         If you plan to use one of the supplied "Reserved Word" files
  73.         (more on them later), it must also be in the directory with the
  74.         program(s) to be processed.  You can have up to nine special
  75.         Reserved Files in the directory and are given the opportunity
  76.         to select one when you start.
  77.  
  78.         Other Options are described next.
  79.  
  80.     COMMAND LINE OPTIONS
  81.  
  82.         The program does not require that any commands be entered when
  83.         it is started. Program defaults and on-screen selections can be
  84.         used.  The program defaults to color display, no left margin, 
  85.         print 10 characters per inch and uses the Microsoft QuickBasic 4.5
  86.         internal reserved word list if no QREFQB.W?? files are available.
  87.       
  88.         Switches have NO on-screen selection process.  Options (except
  89.         one) all have on-screen selections and are mainly a convenience
  90.         you might use if you always process the same way, or want to 
  91.         process lots of program source files the same way.
  92.  
  93.         One Option not selectable on-screen is the "L=n" option.  If you
  94.         want to set the left margin, it must be done on the command line.
  95.  
  96.         To execute the program using command line options and /switches -
  97.  
  98.                 BASICXR O=YYYYF R=BASICXR.Wxx L=n /switches
  99.     
  100.         Options entered on the command line are useful if you plan to
  101.         list/x-ref several programs during the same run using all the
  102.         same options.  It avoids the necessity of key-board input for
  103.         making selections each time you select a program.  It is also
  104.         useful to use the command line options within a batch file,
  105.         particularly if you often want the same options turned on and
  106.         run from a menu system or batch file.
  107.        
  108.                                                                       Page 2
  109.  
  110.         Format is: BASICXR L=n O=12345 R=resword.fil /switches
  111.  
  112.           Where: n = Left Margin setting. Valid values are 0 to 10.
  113.  
  114.                  1 = Y or N (Full Program List)
  115.                  2 = Y or N (Selected Program List)
  116.                  3 = Y or N (User Line Label/Variable Cross Ref)
  117.                  4 = Y or N (Reserved Word Cross Ref)
  118.                  5 = F or P (Printer output to File or Printer)
  119.  
  120.                  resword.fil = Name of Reserved Word file to use
  121.                                (NOT the file to be processed!!)
  122.                  /switches described below
  123.           
  124.  
  125.     SWITCHES
  126.  
  127.                 /M  will force the program to monochrome display.
  128.  
  129.                 /E  will set Epson compatible printers to compressed
  130.                     pitch.  See "Printer Control"
  131.  
  132.                 /T  will set Epson compatible printers to Elite pitch
  133.                     (12 CPI).  See "Printer Control" 
  134.  
  135.                 /D  will set DeskJet compatible printers to compressed
  136.                     pitch.  See "Printer Control"
  137.  
  138.         The "/M" switch can be used in conjunction with either of the
  139.         printer switches.  Order and case are not important, except that
  140.         the /switches all follow ONE "/".
  141.                                                                       
  142.           Example:
  143.                             ___A___ _____B______  _C_ _D_
  144.                     BASICXR O=YNYNF R=BASICXR.WQB /MD L=8
  145.  
  146.               Would:
  147.  
  148.               A] - provide a Full Program List, No Selected List, a Line
  149.                    label and Variable cross reference, No reserved word
  150.                    cross reference, put the output to a file rather than
  151.                    the printer.
  152.  
  153.               B] - Use the file BASICXR.WQB for the list of reserved words
  154.  
  155.               C] - Run Monochrome, and produce compressed print for a
  156.                    DeskJet compatible printer.
  157.               
  158.               D] - Set the Left Margin at 8.
  159.  
  160.               There can be no spaces in the O=xxxxx or the R=xxxxxx.xxx.
  161.        
  162.                                                                       Page 3
  163.  
  164.  
  165.     PRINTER CONTROL
  166.  
  167.         If you elect to print compressed pitch for either an Epson or
  168.         DeskJet compatible printer, start the program with the
  169.         appropriate switch (/E or /D).  The program will send the
  170.         following printer control codes to your printer (or to the
  171.         output file):
  172.  
  173.         Switch  Result               Re-set Code     Set Code
  174.  
  175.            /D   DeskJet compressed   CHR$(27);"E"    CHR$(27);"(s16.67H"
  176.            /E   Epson compressed     CHR$(27);"@"    CHR$(15)
  177.            /T   Epson elite          CHR$(27);"@"    CHR$(27);"M"
  178.  
  179.         In all cases the program resets the printer at the end.
  180.  
  181.     >>NOTE - If you do not execute the program with one of the printer 
  182.              switches, no control codes are sent.  Line width is 80.
  183.  
  184.     PRINTING TO A FILE
  185.  
  186.         By entering "f" or "F" at the prompt you can direct the output
  187.         to files for later printing.  The name of the files created will
  188.         be the same base name as your input source file with an extension
  189.         of ".LST" for listings, ".XRF" for User Cross References and
  190.         ".RWD" for Reserved Word Cross References.  Files will be written
  191.         to the same directory as the source and will contain all printer 
  192.         codes, ready to be copied to a printer.
  193.                                                                      
  194.     SELECTIVE PRINTING
  195.         
  196.         If you want to list only certain sections of a program, each
  197.         section to be listed must be "marked" to Start List and EndList.
  198.  
  199.         This is done by entering the following:
  200.                        '>       To start list section
  201.                        '<       To end list section
  202.         All lines between the  '>  and  '<  will be listed (printed).
  203.         
  204.         The ' character (single quote) is shorthand for REM, so it will
  205.         have no effect on your program.
  206.  
  207.         Selective printing is mutually excusive with Full List.  If you
  208.         select "Full Program Listing", these codes will have no effect,
  209.         and the whole program will be listed.
  210.        
  211.                                                                       Page 4
  212.         
  213.     FORCING A PAGE EJECT
  214.  
  215.         If you would like to force a page eject in the program listing,
  216.         simply insert a line with two single quotes as the only text on
  217.         the line - '' - NOT a double quote (").
  218.  
  219.         The single quote is shorthand for REM, so the two single quotes
  220.         will not affect your program, but will trigger a page eject in
  221.         BASICXR.
  222.  
  223.     RESERVED WORD FILES
  224.  
  225.         BASICXR has a built in table of Microsoft QuickBasic 4.5 reserved
  226.         words.  For another dialect of Basic you can create your own set
  227.         in a file that must be called "BASICXR.W??".  This is simply a
  228.         text file of the reserved words.  Three reserved word files are 
  229.         furnished with BASICXR.  They are:
  230.  
  231.                     BASICXR.WQB - for Microsoft QBasic
  232.                     BASICXR.W45 - for Microsoft QuickBasic 4.5 (same as the
  233.                                      DEFAULT contained within the program
  234.                     BASICXR.WPD - for Microsoft PDS, Professional Development
  235.                                      System.
  236.  
  237.         If your programs are written only in Microsoft QuickBasic 4.5 you do
  238.         not need any of these.  The program default will work.
  239.  
  240.         If you use add-on routines, such as Crescent Software or Micro-Help
  241.         routines, which contain substantial addidional commands, you should
  242.         use one of the above files as a starter to create a new one for your
  243.         own use.  Just use any text editor to add to the list and name it 
  244.         "BASICXR.W??" as mentioned above.
  245.  
  246.         Maximum size of BASICXR.W?? is 600 entries.
  247.         Maximum record length for each entry is 16.
  248.        
  249.                                                                       Page 5
  250.                                                                   
  251.  
  252.     REQUIREMENTS/LIMITATIONS
  253.  
  254.         Minimum requirements to run BASICXR are:
  255.  
  256.                 IBM compatible computer
  257.                 Monochrome or color monitor
  258.                 Printer (unless printing to a file)
  259.                 DOS 3.xx or higher
  260.                 256K
  261.  
  262.         Programs to be cross-referenced must be saved in ASCII and have
  263.         the extension ".BAS".
  264.  
  265.         The program assumes Microsoft Basic dialects.  I do not guarantee
  266.         any other versions of Basic, although it might work.
  267.  
  268.         It will NOT work with GWBasic, or any dialect using line numbers.
  269.         Even though both QBasic and QuickBasic support line numbers,
  270.         BASICXR will NOT work with any programs containing line numbers.
  271.  
  272.         Customized Reserved Word files - Must be on the directory with the
  273.         programs to be processes.  Limited to nine files, maximum 600 
  274.         entries on each file, maximum record length 16.  They must have a
  275.         name starting with "BASICXR.W" to be recognized by BASICXR.  The last
  276.         two charcacters are your choice.
  277.  
  278.         The size of the program it can handle is based on how much main
  279.         memory you have (up to 640K) and how many references there are.
  280.         If it runs out of room for the reference table, the program
  281.         notifies you, marks the listing where referencing will stop, and
  282.         continues the listing, if that option is turned on.
  283.  
  284.         The solution at this point would be to break the program into
  285.         several parts and then run each part thru BASICXR.
  286.  
  287.  
  288.     SUPPORT
  289.  
  290.         Registered owners will receive free support for three months
  291.         after registration by contacting me thru US mail, CompuServe or
  292.         phone at:
  293.  
  294.                 Jane N. Goodale           
  295.                 7826 Littlejohn Court     
  296.                 Charlotte,  NC  28227
  297.                 (704)-537-0329            CompuServe address:  71116,302
  298.  
  299.     REGISTRATION
  300.  
  301.         Registration is available for $15.  You can fill out and print
  302.         the registration form within the program BASICXR.EXE or from
  303.         the order blank "REGISTER.DOC".
  304.  
  305.         If you distribute copies of this program, please assure that
  306.         all files and documentation are present.
  307.        
  308.                                                                       Page 6
  309.  
  310.     SHAREWARE CONCEPT/OMBUDSMAN INFORMATION
  311.  
  312.         Shareware distribution gives users a chance to try software
  313.         before buying it.  If you try a Shareware program and continue
  314.         using it, you are expected to register.
  315.  
  316.         Shareware is a distribution method, not a type of software.  You
  317.         should find software that suits your needs and pocketbook, whether
  318.         it's commercial or Shareware.  The Shareware system makes fitting
  319.         your needs easier, because you can try before you buy.  And because
  320.         the overhead is low, prices are low also.  Shareware has the
  321.         ultimate money-back guarantee -- if you don't use the product,
  322.         you don't pay for it!
  323.  
  324.  
  325.                Association Of Shareware Professionals Ombudsmen
  326.  
  327.         This program is produced by a member of the Association of
  328.         Shareware Professionals (ASP).  ASP wants to make sure that the
  329.         shareware principle works for you.  If you are unable to resolve a
  330.         shareware-related problem with an ASP member by contacting the
  331.         member directly, ASP may be able to help.  The ASP Ombudsman can
  332.         help you resolve a dispute or problem with an ASP member, but does
  333.         not provide technical support for members' products.  Please write
  334.         to the ASP Ombudsman at P.O. Box 5786, Bellevue, WA 98006 or send
  335.         a Compuserve message via easyplex to ASP Ombudsman 70007,3536
  336.  
  337.  
  338.                          .... End of BASICXR.DOC ....
  339.